Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #2746 Create the Docs microservice #2776

Closed

Conversation

cindyorangis
Copy link
Contributor

Issue This PR Addresses

#2746

Type of Change

  • Bugfix: Change which fixes an issue
  • New Feature: Change which adds functionality
  • Documentation Update: Change which improves documentation
  • UI: Change which improves UI

Description

How to review this PR locally the old-school way. Gitpod might work but I haven't tried it yet.

  1. Add my repository as a remote: git remote add cindyledev https://github.com/cindyledev/telescope.git
  2. Fetch my branches: git fetch cindyledev
  3. Checkout my branch: git checkout docs-microservice
  4. Install dependencies: pnpm install
  5. Start the Docker containers: pnpm services:start

This is the first time I'm creating a microservice so I'm having some trouble with how either Traefik is stripping the URL or perhaps something to do with the Next.js side?

Visiting localhost:4631 takes you to the Next.js app running in the Docker container as expected
Screenshot 2022-01-29 144335

However, when you visit the API route localhost/v1/docs, you get an 202 OK response which is also good
Screenshot 2022-01-29 144208

but it thinks the Next.js files are at localhost/_next/*, I want it route to localhost/v1/docs/_next/*

Screenshot 2022-01-29 144314

If you manually go to http://localhost/v1/docs/favicon.ico

Screenshot 2022-01-29 144434

Checklist

  • Quality: This PR builds and passes our npm test and works locally
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
  • Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

@gitpod-io
Copy link

gitpod-io bot commented Jan 29, 2022

@cindyorangis cindyorangis self-assigned this Jan 29, 2022
@cindyorangis cindyorangis added area: microservices area: nextjs Nextjs related issues developer experience Helping the Developer Experience type: documentation (docs) Improvements or additions to documentation type: nice to have Feature that'd be nice to have, but not a priority labels Jan 29, 2022
@cindyorangis cindyorangis added this to the 2.8 Release milestone Jan 29, 2022
@cindyorangis cindyorangis linked an issue Jan 29, 2022 that may be closed by this pull request
@humphd
Copy link
Contributor

humphd commented Jan 30, 2022

If our goal is a docs web site, should we use a docs-website base instead (e.g., Docusaurus)? We just did a big rewrite of the docs for the C notes, see https://github.com/Seneca-ICTOER/Intro2C, and it was nice not to have to worry about a lot of stuff we'd have to do manually here with next.js.

Just a thought, it doesn't have to be this.

@cindyorangis
Copy link
Contributor Author

I'm gonna dig into Docusaurus again since this microservice Next.js approach is taking a long time to get to market because we're building from the ground up and I can already see all the technical debt in its wake sorry LOL

@cindyorangis
Copy link
Contributor Author

Scrapping this approach

@cindyorangis cindyorangis removed this from the 2.8 Release milestone Feb 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: microservices area: nextjs Nextjs related issues developer experience Helping the Developer Experience type: documentation (docs) Improvements or additions to documentation type: nice to have Feature that'd be nice to have, but not a priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create the Docs Microservice
2 participants